home *** CD-ROM | disk | FTP | other *** search
/ InterCD 2001 June / june_2001.iso / Tools / NeoTrace Pro / setup.exe / %MAINDIR% / ExternalApps / config.README next >
Encoding:
Text File  |  2001-01-11  |  2.8 KB  |  77 lines
  1. Configuration File README
  2. -------------------------
  3.  
  4. An external application configuration file must be located off of the ExternalApps
  5. directory and must have the extension ".config".  The file consists of five
  6. lines with each line as follows:
  7.  
  8. Menu name
  9. Description
  10. Command Path
  11. Command Name
  12. Command Parameters
  13.  
  14. The first line the Menu name is the name that the external application
  15. will have in the external application submenu.
  16.  
  17. The second line is a description of the configuration file.  This line is
  18. ignored and can be treated as comment line.
  19.  
  20. The third line contains the command path and is the absolute path of the 
  21. command.  If nothing is present then the PATH environment variable will
  22. be used to try and find the executable.
  23.  
  24. The fourth line contains the name of the executable.
  25.  
  26. The fifth line contains the parameters passed to the executable, i.e., command
  27. line arguments.
  28.  
  29. The command name and command parameters can contain variables.  The list of
  30. allowable variables is
  31.  
  32. %x    Hostname, if available, else the IP address
  33. %H    Hostname
  34. %I    IP address
  35. %D    Domain Name
  36. %N    Netname
  37. %T    Round Trip Time
  38. %A    Latitude
  39. %G    Longitude
  40.  
  41. Variables present on the first three lines in the configuration file will not be
  42. interpreted as variables.
  43.  
  44. As an example, the configuration file for ftp is (the line numbers are added for
  45. clarity):
  46.  
  47. 1: Ftp
  48. 2: # Description
  49. 3: 
  50. 4: ftp
  51. 5: %X
  52.  
  53.  
  54. Notes:
  55.  
  56. 1) The line containing the command name and the command parameters can contain the character '%'
  57. as long as the character following does not make one of the above variable names.  As an example,
  58.  
  59. 1: Show Map
  60. 2: # Description
  61. 3:
  62. 4: http://www.mapblast.com/mblast/map.mb?loc=ll&worldres=&CMD=LFILL&auto=1&MA=3&CT%3A=%A&CT%3A=%G&CT=2000000
  63.                                                                                   --  --   --  --
  64.                                                                                   ^   ^    ^   ^
  65.                                                                                   |   |    |   |
  66.                                                                 Not a variable ----   |    |   |
  67.                                                                 A variable ------------    |   |
  68.                                                                 Not a variable -------------   |
  69.                                                                 A variable ---------------------
  70.  
  71. 2) If there are no command parameters needed for the external application the last line does not
  72. have to be present, i.e., the fifth line does not have to contain a newline character.  The
  73. program can handle this situation.
  74.  
  75. 3) All configuration files are read in once, at program startup, therefore, if changes are made to
  76. a configuration file and Neotrace is running, the program must be restarted for Neotrace to
  77. recognize the changes.